/*
 *    Copyright 2009-2022 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.session;

import java.io.Closeable;
import java.sql.Connection;
import java.util.List;
import java.util.Map;

import org.apache.ibatis.cursor.Cursor;
import org.apache.ibatis.executor.BatchResult;

/**
 * The primary Java interface for working with MyBatis.
 * Through this interface you can execute commands, get mappers and manage transactions.
 *
 * @author Clinton Begin
 */
// 使用 MyBatis 的主要 Java 接口。
// 通过此接口，您可以执行命令、获取映射器和管理事务。
public interface SqlSession extends Closeable {

  /**
   * Retrieve a single row mapped from the statement key.
   * @param <T> the returned object type
   * @param statement
   *          the statement
   * @return Mapped object
   */
  // 检索从语句键映射的单行。
  // 参数：声明——声明
  // 类型参数： <T> – 返回的对象类型
  // 回报：映射对象
  <T> T selectOne(String statement);

  /**
   * Retrieve a single row mapped from the statement key and parameter.
   * @param <T> the returned object type
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @return Mapped object
   */
  // 检索从语句键和参数映射的单行
  <T> T selectOne(String statement, Object parameter);

  /**
   * Retrieve a list of mapped objects from the statement key.
   * @param <E> the returned list element type
   * @param statement Unique identifier matching the statement to use.
   * @return List of mapped object
   */
  // 从语句键中检索映射对象列表。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // 类型参数：
  // <E> – 返回的列表元素类型
  // 回报：
  // 映射对象列表
  <E> List<E> selectList(String statement);

  /**
   * Retrieve a list of mapped objects from the statement key and parameter.
   * @param <E> the returned list element type
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @return List of mapped object
   */
  // 从语句键和参数中检索映射对象列表。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // 类型参数：
  // <E> – 返回的列表元素类型
  // 回报：
  // 映射对象列表
  <E> List<E> selectList(String statement, Object parameter);

  /**
   * Retrieve a list of mapped objects from the statement key and parameter,
   * within the specified row bounds.
   * @param <E> the returned list element type
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @param rowBounds  Bounds to limit object retrieval
   * @return List of mapped object
   */
  // 从语句键和参数中检索指定行范围内的映射对象列表。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // rowBounds – 限制对象检索的界限
  // 类型参数：
  // <E> – 返回的列表元素类型
  // 回报：
  // 映射对象列表
  <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds);

  /**
   * The selectMap is a special case in that it is designed to convert a list
   * of results into a Map based on one of the properties in the resulting
   * objects.
   * Eg. Return a of Map[Integer,Author] for selectMap("selectAuthors","id")
   * @param <K> the returned Map keys type
   * @param <V> the returned Map values type
   * @param statement Unique identifier matching the statement to use.
   * @param mapKey The property to use as key for each value in the list.
   * @return Map containing key pair data.
   */
  // selectMap 是一种特殊情况，它旨在根据结果对象中的一个属性将结果列表转换为 Map。
  // 例如。 为 selectMap("selectAuthors","id") 返回一个 Map[Integer,Author]
  <K, V> Map<K, V> selectMap(String statement, String mapKey);

  /**
   * The selectMap is a special case in that it is designed to convert a list
   * of results into a Map based on one of the properties in the resulting
   * objects.
   * @param <K> the returned Map keys type
   * @param <V> the returned Map values type
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @param mapKey The property to use as key for each value in the list.
   * @return Map containing key pair data.
   */
  // selectMap 是一种特殊情况，它旨在根据结果对象中的一个属性将结果列表转换为 Map。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // mapKey – 用作列表中每个值的键的属性。
  // 类型参数：
  // <K> – 返回的 Map 键类型
  // <V> – 返回的 Map 值类型
  // 回报：
  // 包含密钥对数据的映射。
  <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey);

  /**
   * The selectMap is a special case in that it is designed to convert a list
   * of results into a Map based on one of the properties in the resulting
   * objects.
   * @param <K> the returned Map keys type
   * @param <V> the returned Map values type
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @param mapKey The property to use as key for each value in the list.
   * @param rowBounds  Bounds to limit object retrieval
   * @return Map containing key pair data.
   */
  // selectMap 是一种特殊情况，它旨在根据结果对象中的一个属性将结果列表转换为 Map。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // mapKey – 用作列表中每个值的键的属性。
  // rowBounds – 限制对象检索的界限
  // 类型参数：
  // <K> – 返回的 Map 键类型
  // <V> – 返回的 Map 值类型
  // 回报：
  // 包含密钥对数据的映射。
  <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds);

  /**
   * A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.
   * @param <T> the returned cursor element type.
   * @param statement Unique identifier matching the statement to use.
   * @return Cursor of mapped objects
   */
  // Cursor 提供与 List 相同的结果，只是它使用 Iterator 懒惰地获取数据。
  <T> Cursor<T> selectCursor(String statement);

  /**
   * A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.
   * @param <T> the returned cursor element type.
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @return Cursor of mapped objects
   */
  // Cursor 提供与 List 相同的结果，只是它使用 Iterator 懒惰地获取数据。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // 类型参数：
  // <T> – 返回的游标元素类型。
  // 回报：
  // 映射对象的光标
  <T> Cursor<T> selectCursor(String statement, Object parameter);

  /**
   * A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.
   * @param <T> the returned cursor element type.
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @param rowBounds  Bounds to limit object retrieval
   * @return Cursor of mapped objects
   */
  // Cursor 提供与 List 相同的结果，只是它使用 Iterator 懒惰地获取数据。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // rowBounds – 限制对象检索的界限
  // 类型参数：
  // <T> – 返回的游标元素类型。
  // 回报：
  // 映射对象的光标
  <T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds);

  /**
   * Retrieve a single row mapped from the statement key and parameter
   * using a {@code ResultHandler}.
   * @param statement Unique identifier matching the statement to use.
   * @param parameter A parameter object to pass to the statement.
   * @param handler ResultHandler that will handle each retrieved row
   */
  // 使用ResultHandler检索从语句键和参数映射的单行
  void select(String statement, Object parameter, ResultHandler handler);

  /**
   * Retrieve a single row mapped from the statement
   * using a {@code ResultHandler}.
   * @param statement Unique identifier matching the statement to use.
   * @param handler ResultHandler that will handle each retrieved row
   */
  // 使用ResultHandler检索从语句映射的单行。
  //
  // 参数：
  // statement – 与要使用的语句匹配的唯一标识符。
  // handler – ResultHandler 将处理每个检索到的行
  void select(String statement, ResultHandler handler);

  /**
   * Retrieve a single row mapped from the statement key and parameter using a {@code ResultHandler} and
   * {@code RowBounds}.
   *
   * @param statement
   *          Unique identifier matching the statement to use.
   * @param parameter
   *          the parameter
   * @param rowBounds
   *          RowBound instance to limit the query results
   * @param handler
   *          ResultHandler that will handle each retrieved row
   */
  // 使用ResultHandler和RowBounds检索从语句键和参数映射的单行。
  // 参数：statement – 与要使用的语句匹配的唯一标识符。
  // 参数 - 参数
  // rowBounds - 限制查询结果的 RowBound 实例
  // handler – ResultHandler 将处理每个检索到的行
  void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler);

  /**
   * Execute an insert statement.
   * @param statement Unique identifier matching the statement to execute.
   * @return int The number of rows affected by the insert.
   */
  // 执行插入语句。
  //
  // 参数：
  // statement – 与要执行的语句匹配的唯一标识符。
  // 回报：
  // int 受插入影响的行数。
  int insert(String statement);

  /**
   * Execute an insert statement with the given parameter object. Any generated
   * autoincrement values or selectKey entries will modify the given parameter
   * object properties. Only the number of rows affected will be returned.
   * @param statement Unique identifier matching the statement to execute.
   * @param parameter A parameter object to pass to the statement.
   * @return int The number of rows affected by the insert.
   */
  // 使用给定的参数对象执行插入语句。 任何生成的自动增量值或 selectKey 条目都将修改给定的参数对象属性。 只会返回受影响的行数。
  // 参数：
  // statement – 与要执行的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // 回报：int 受插入影响的行数。
  int insert(String statement, Object parameter);

  /**
   * Execute an update statement. The number of rows affected will be returned.
   * @param statement Unique identifier matching the statement to execute.
   * @return int The number of rows affected by the update.
   */
  // 执行更新语句。将返回受影响的行数。
  //
  // 参数：
  // statement – 与要执行的语句匹配的唯一标识符。
  // 回报：
  // int 受更新影响的行数。
  int update(String statement);

  /**
   * Execute an update statement. The number of rows affected will be returned.
   * @param statement Unique identifier matching the statement to execute.
   * @param parameter A parameter object to pass to the statement.
   * @return int The number of rows affected by the update.
   */
  // 执行更新语句。将返回受影响的行数。
  //
  // 参数：
  // statement – 与要执行的语句匹配的唯一标识符。
  // parameter -- 要传递给语句的参数对象。
  // 回报：
  // int 受更新影响的行数。
  int update(String statement, Object parameter);

  /**
   * Execute a delete statement. The number of rows affected will be returned.
   * @param statement Unique identifier matching the statement to execute.
   * @return int The number of rows affected by the delete.
   */
  int delete(String statement);

  /**
   * Execute a delete statement. The number of rows affected will be returned.
   * @param statement Unique identifier matching the statement to execute.
   * @param parameter A parameter object to pass to the statement.
   * @return int The number of rows affected by the delete.
   */
  int delete(String statement, Object parameter);

  /**
   * Flushes batch statements and commits database connection.
   * Note that database connection will not be committed if no updates/deletes/inserts were called.
   * To force the commit call {@link SqlSession#commit(boolean)}
   */
  // 刷新批处理语句并提交数据库连接。请注意，如果没有调用更新/删除/插入，则不会提交数据库连接。强制提交调用commit(boolean)
  void commit();

  /**
   * Flushes batch statements and commits database connection.
   * @param force forces connection commit
   */
  // 刷新批处理语句并提交数据库连接。
  //
  // 参数：
  // force - 强制连接提交
  void commit(boolean force);

  /**
   * Discards pending batch statements and rolls database connection back.
   * Note that database connection will not be rolled back if no updates/deletes/inserts were called.
   * To force the rollback call {@link SqlSession#rollback(boolean)}
   */
  //丢弃挂起的批处理语句并回滚数据库连接。
  // 请注意，如果没有调用更新/删除/插入，则不会回滚数据库连接。强制回滚调用rollback(boolean)
  void rollback();

  /**
   * Discards pending batch statements and rolls database connection back.
   * Note that database connection will not be rolled back if no updates/deletes/inserts were called.
   * @param force forces connection rollback
   */
  // 丢弃挂起的批处理语句并回滚数据库连接。请注意，如果没有调用更新/删除/插入，则不会回滚数据库连接。
  //
  // 参数：
  // force - 强制连接回滚
  void rollback(boolean force);

  /**
   * Flushes batch statements.
   * @return BatchResult list of updated records
   * @since 3.0.6
   */
  // 刷新批处理语句。
  //
  // 回报：
  // BatchResult 更新记录列表
  List<BatchResult> flushStatements();

  /**
   * Closes the session.
   */
  @Override
  void close();

  /**
   * Clears local session cache.
   */
  void clearCache();

  /**
   * Retrieves current configuration.
   * @return Configuration
   */
  Configuration getConfiguration();

  /**
   * Retrieves a mapper.
   * @param <T> the mapper type
   * @param type Mapper interface class
   * @return a mapper bound to this SqlSession
   */
  // 检索映射器。
  //
  // 参数：
  // type – 映射器接口类
  // 类型参数：
  // <T> – 映射器类型
  // 回报：
  // 绑定到此 SqlSession 的映射器
  <T> T getMapper(Class<T> type);

  /**
   * Retrieves inner database connection.
   * @return Connection
   */
  Connection getConnection();
}
